MDC Documents System API
API Policies
The following policies are applied to the API via API Manager:
Client ID Enforcement Policy
The purpose of the Client ID Enforcement policy is to allow access only to authorised client applications. The Client Id Enforcement policy is used to restrict access to a protected resource by allowing requests only from registered client applications.
Client ID enforcement enables the client to be authorised to be able to use the API. Received request from the client must have the following required values or the client will receive a 401 unauthorised status code.
| Parameter | Location | Description |
|---|---|---|
| client_id | Request Header | Client ID is unique identified assigned to the client application. |
| client_secret | Request Header | Client secret is a key assigned to the client ID parameter when access is requested and approved via the Exchange portal. |
Spike Control Policy
The Spike Control policy regulates your API request traffic by limiting the number of messages processed by an API. The policy ensures that the number of messages processed within a specified time does not exceed the limit that you configure. If the number is exceeded, the request is queued for retry based on you have configured the policy.
| Value | Element | Description |
|---|---|---|
| 5 | Number of Reqs | The number of requests allowed (in milliseconds) in the specified window. |
| 1000 | Time Period | The number of milliseconds, within which a request must be processed. |
| 1000 | Delay Time in Milliseconds | The amount of time for which each request is retained before retrying (in milliseconds) in case there is no quota remaining |
| 1 | Delay Attempts | The number of times a request is retried before it is rejected. |
| 5 | Queuing Limit | The number of requests that can be queued at the any given time. |
| true | Expose headers | Enabled only for internal APIs, allows the policy to return information about the algorithm behavior in the X-RateLimit headers. |
| - | Method & Resource conditions | The option to add configurations to only a select few or all methods and resources of the API. |